home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / Internet Config 1.2 / Internet Config / APIs / ICCAPI.p < prev    next >
Encoding:
Text File  |  1995-09-25  |  27.6 KB  |  82 lines  |  [TEXT/CWIE]
  1. unit ICCAPI;
  2.  
  3. (* •••Start Header••• *)
  4.  
  5. (* File:         ICCAPI.p (intf)
  6.  * Generated by: 1.0d4
  7.  * For:          IC 1.2
  8.  * On:           Monday, 25 September 1995, 19:28:12
  9.  * 
  10.  * This file is part of the Internet Configuration system and
  11.  * is placed in the public domain for the benefit of all.
  12.  *)
  13.  
  14. (* •••End Header••• *)
  15.  
  16. interface
  17.  
  18.     uses
  19. {$ifc undefined THINK_Pascal}
  20.         Types, Files, QuickDraw, AppleTalk, Aliases, 
  21. {$endc}
  22.         Components, ICTypes, ICKeys;
  23.  
  24.     const
  25.         internetConfigurationComponentType = 'PREF';                (* the component type *)
  26.         internetConfigurationComponentSubType = 'ICAp';            (* the component subtype *)
  27.         internetConfigurationComponentInterfaceVersion0 = $00000000;
  28.         internetConfigurationComponentInterfaceVersion1 = $00010000;
  29.         internetConfigurationComponentInterfaceVersion2 = $00020000;
  30. (* current version number is version 2 *)
  31.         internetConfigurationComponentInterfaceVersion = internetConfigurationComponentInterfaceVersion2;
  32.  
  33. (* •••Start ICCAPI.p••• *)
  34.  
  35.   (* ***** Starting Up and Shutting Down ***** *)
  36.   
  37.   function ICCStart(var inst : ComponentInstance; creator : OSType) : ICError;
  38.     (* Call this at application initialisation. Set creator to your application
  39.      * creator to allow for future expansion of the IC system. Returns
  40.      * inst as a connection to the IC system.
  41.      *)
  42.   
  43.   function ICCStop(inst : ComponentInstance) : ICError;
  44.     (* It is illegal to call this routine inside a ICBegin/End pair.
  45.      * Call this at application initialisation, after which inst
  46.      * is no longer valid connection to IC.
  47.      *)
  48.   
  49.   (* ***** Specifying a Configuration ***** *)
  50.   
  51.   function ICCFindConfigFile(inst : ComponentInstance; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  52.   {$ifc not GeneratingCFM}
  53.     inline $2F3C, 6, 2, $7000, $A82A;
  54.   {$endc}
  55.     (* It is illegal to call this routine inside a ICBegin/End pair.
  56.      * Call to configure this connection to IC.
  57.      * Set count as the number of valid elements in folders.
  58.      * Set folders to a pointer to the folders to search.
  59.      * Setting count to 0 and folders to nil is OK.
  60.      * Searches the specified folders and then the Preferences folder
  61.      * in a unspecified manner.
  62.      *)
  63.   
  64.   function ICCFindUserConfigFile(inst : ComponentInstance; var where : ICDirSpec) : ICError;
  65.   {$ifc not GeneratingCFM}
  66.     inline $2F3C, 4, 14, $7000, $A82A;
  67.   {$endc}
  68.     (* Requires IC 1.1.
  69.      * It is illegal to call this routine inside a ICBegin/End pair.
  70.      * Similar to ICFindConfigFile except that it only searches the folder
  71.      * specified in where.  If the input parameters are valid the routine
  72.      * will always successful configure the instance, creating an
  73.      * empty configuration if necessary
  74.      * For use with double-clickable preference files.
  75.      *)
  76.   
  77.   function ICCGeneralFindConfigFile(inst : ComponentInstance; search_prefs : Boolean; can_create : Boolean; count : integer; folders : ICDirSpecArrayPtr) : ICError;
  78.   {$ifc not GeneratingCFM}
  79.     inline $2F3C, 10, 30, $7000, $A82A;
  80.   {$endc}
  81.     (* Requires IC 1.2.
  82.      * It is ille